System and method to enable searching across multiple databases and files using a single search

ABSTRACT

According to one aspect of the present invention, a method includes receiving a search category and a search keyword entered by a user. The method also includes performing a single search on at least one database and at least one attached document for data records matching the search category and the search keyword. The method further includes generating search results comprising of the data records matching the search category and the search keyword.

FIELD OF THE INVENTION

The present invention relates generally to the field of data processing.More specifically, the present invention relates to a system and methodto enable searching across multiple databases and files using a singlesearch.

BACKGROUND OF THE INVENTION

As technology continues to advance and the business environments havebecome increasingly complex and diverse, more and more companies haverelied on various customer relationship management (CRM) software andeBusiness applications to conduct and manage various aspects of theirenterprise business. In general, eBusiness applications are designed toenable a company or enterprise to conduct its business over aninteractive network (e.g., Internet, Intranet, Extranet, etc.) with itscustomers, partners, suppliers, distributors, employees, etc. eBusinessapplications may include core business processes, supply chain,back-office operations, and CRM functions. CRM generally includesvarious aspects of interaction a company has with its customers,relating to sales and/or services. At a high level, customerrelationship management is focused on understanding the customer's needsand leveraging this knowledge to increase sales and improve service. CRMapplication and software is generally designed to provide effective andefficient interactions between sales and service, and unify a company'sactivities around the customer in order to increase customer share andcustomer retention through customer satisfaction.

Typically, CRM implementation strategy needs to consider the following:

-   -   Knowledge Management: one of the important factors of an        effective CRM implementation is the acquisition of information        about a customer, its analysis, sharing and tracking. Also        integral to the use of knowledge for competitive advantage is        for employees to know what actions to take as a result of this        knowledge.    -   Database Consolidation: another important aspect of an effective        and efficient CRM solution is the consolidation of customer        information in a single database and the re-engineering of        business processes around the customer. The goal here is to have        all interactions with a customer recorded in one place to drive        production, marketing, sales and customer support activities.    -   Integration of Channels and Systems: it is very important for a        CRM application/software to provide the capability to respond to        customers in a consistent and high-quality manner through their        channel of choice, whether that is the e-mail, the phone,        web-based user interfaces, etc. This may require the seamless        integration of various communication channels with the customer        or enterprise database. It also may require the integration of        CRM with other parts of a company's business systems and        applications.    -   Technology and Infrastructure: to enhance customer services, a        CRM application/software may include various tools to automate        and streamline online customer service. For example, a self-help        model typically can be implemented using a combination of tools        (e.g. knowledge bases with an intuitive search capability, agent        technology or automated email, etc.).

Generally, eBusiness applications are designed to allow organizations tocreate a single source of customer information that makes it easier tosell to, market to, and service customers across multiple channels,including the Web, call centers, field, resellers, retail, and dealernetworks. Advanced eBusiness applications are typically built on acomponent-based architecture and are designed to be Web-based and todeliver support for various types of clients on multiple computingplatforms including mobile clients, connected clients, thin clients, andhandheld clients, etc.

Intense competition for customer attention, pervasive channel expansion,and the Internet explosion have spawned unprecedented levels of customerchoice. With the right solution in place, each interaction presents anopportunity to better understand the unique needs of the customer orextended household. By capitalizing on customer information capturedduring each interaction (e.g., through a call center), organizations cansuggest the best combination of products and services to meet thecustomer's objectives and thereby increasing the chances that thecustomer will remain loyal.

Traditionally, the role of the call center has been limited to handlingtelephone calls from customers who were reporting service outages,activating or canceling service, or inquiring about standard billing andcollection issues. The metrics of success were based on efficientdelivery of service and operating the customer call center asinexpensively as possible. Customer interaction was considered a “cost”of doing business.

However as customers demand consistent service and sales support throughevery channel of communication, call centers are quickly evolving intocomplete customer contact centers. The call center's importance israpidly escalating as it increasingly provides support for all customerinteractions. Call centers now typically implement solutions providingthe following capabilities:

Easy to use, unified agent desktop to allow an agent to handlemultimedia interactions through a single user interface;

Consolidated view of the customer to ensure that each agent has completeknowledge of every interaction across all channels of communicationincluding telephone, email, Web chat, Web voice, fax, and page;

Workflow automation and dynamic scripting to ensure that work is handledin the most efficient manner and that business processes and policiesare always enforced;

Integrated sales, marketing, and customer service including inbound andoutbound telesales, email response, and Web campaigns; and

Comprehensive Web-based architecture to allow rapid applicationdeployment and an off-the-shelf solution to minimize the total cost ofownership.

In order to support the aforementioned capabilities, an extensivedatabase is required to store customer related information. At times, itis critical for users of this extensive database to be able to searchthe database and quickly retrieve a record or piece of information. Inan exemplary scenario, a manager for a computing support group receivesa call from a customer trying to find out information about thecustomer's account and also requesting a specific marketing literatureitem. In this exemplary scenario, it is highly desirable to have acentral facility that could quickly and efficiently peruse through theextensive database to locate the information that the customerrequested.

BRIEF DESCRIPTION OF THE DRAWINGS

The features and advantages of the present invention will be more fullyunderstood by reference to the accompanying drawings, in which:

FIG. 1 shows a multi-layered system architecture in which the teachingsof the present invention are implemented;

FIG. 2 shows various system components that may be included in themulti-layered architecture shown in FIG. 1;

FIG. 3 illustrates the major components of a HTML thin client systemconfiguration;

FIG. 4 illustrates an exemplary Search Tool Bar Icon in accordance withone embodiment of the present invention;

FIG. 5 illustrates an exemplary Search Center Frame or Pane inaccordance with one embodiment of the present invention;

FIG. 6 is a flow chart generally outlining an exemplary process ofcreating various Search objects;

FIG. 7 is a flow chart generally outlining an exemplary process ofcreating a Search Engine object in accordance with one embodiment of thepresent invention;

FIG. 8 generally illustrates properties of a Search Engine object inaccordance with one embodiment of the present invention;

FIG. 9 generally illustrates properties of an exemplary Result Fieldobject in accordance with one embodiment of the present invention;

FIG. 10 is a flow chart generally outlining an exemplary process ofcreating a Search Index object in accordance with one embodiment of thepresent invention;

FIG. 11 generally illustrates properties of an exemplary Search Indexobject 1100 in accordance with one embodiment of the present invention;

FIG. 12 generally illustrates properties of an exemplary Search Tableobject 1200 in accordance with one embodiment of the present invention;

FIG. 13 is a flow chart generally outlining an exemplary process ofcreating an Index Field Map object for each created Search Table inaccordance with one embodiment of the present invention;

FIG. 14A generally illustrates properties of an exemplary Index Fieldobject in accordance with one embodiment of the present invention;

FIG. 14B generally illustrates properties of an exemplary Filter Fieldobject in accordance with one embodiment of the present invention;

FIG. 15 is a flow chart generally outlining an exemplary process ofcreating and configuring a Search Category object;

FIG. 16 generally illustrates properties of an exemplary Search Categoryobject in accordance with one embodiment of the present invention;

FIG. 17 generally illustrates properties of an exemplary Pick Viewobject in accordance with one embodiment of the present invention;

FIG. 18A is a flow chart generally outlining an exemplary process ofcreating and configuring a Search Definition object;

FIG. 18B generally illustrates properties of a Search Definition objectin accordance with one embodiment of the present invention;

FIG. 19 generally illustrates properties of an exemplary Search Categoryobject associated with a Search Definition in accordance with oneembodiment of the present invention;

FIG. 20 generally illustrates properties of an exemplary Custom ResultField object in accordance with one embodiment of the present invention;

FIG. 21 shows a summary of the relationship between these exemplarySearch objects described above;

FIG. 22 is a flow chart generally outlining an exemplary process of howa search is executed in accordance with one embodiment of the presentinvention;

FIG. 23 illustrates a block diagram of a system in accordance with oneembodiment of the present invention;

FIG. 24 illustrates an exemplary Search Frame in accordance with oneembodiment of the present invention;

FIG. 25 shows an exemplary Search Selection View in accordance with oneembodiment of the present invention;

FIG. 26 shows an exemplary Basic Search View and Basic Search ResultsView in accordance with one embodiment of the present invention;

FIG. 27 shows an exemplary Advanced Search View and Advanced SearchResults View in accordance with one embodiment of the present invention;

FIG. 28 shows an exemplary Search Term Separator control in accordancewith one embodiment of the present invention

FIG. 30 illustrates an exemplary Search Indices View in accordance withone embodiment of the present invention;

FIG. 31 shows an exemplary Search Execution Settings View in accordancewith one embodiment of the present invention;

FIG. 32 shows an exemplary Search Administration Settings View inaccordance with one embodiment of the present invention;

FIG. 33 illustrates a de-normalization of records using an intersectiontable;

FIG. 34 shows a flow diagram of one embodiment of a method for indexingand de-normalizing records;

FIG. 35 illustrates a flow diagram of a method according to theteachings of the present invention;

FIG. 36 shows a diagram of one embodiment of a logical data modelaccording to the teachings of the present invention;

FIG. 37 shows a more detailed block diagram of one embodiment of thelogical data model illustrated in FIG. 36;

FIG. 38 shows a block diagram of one embodiment of a logical data modelillustrating the relationship between various business components;

FIG. 39 shows a flow diagram of one embodiment of a method for indexingand de-normalizing records according to the teachings of the presentinvention;

FIG. 40 shows a flow diagram of one embodiment of a process according tothe teachings of the present invention;

FIG. 41 illustrates a flow diagram of one embodiment of a method forcreating filter search specifications in accordance with the teachingsof the present invention;

FIG. 42 shows a flow diagram of one embodiment of a method according tothe teachings of the present invention;

FIG. 43 shows a flow diagram of one embodiment of a method according tothe teachings of the present invention;

FIG. 44 shows a flow diagram of one embodiment of anattachment/association process according to the teachings of the presentinvention;

FIG. 45 shows a flow diagram of one embodiment of a preview processaccording to the teachings of the present invention;

FIG. 46 illustrates a high level flow diagram of one embodiment of aprocess for performing remote search indexing;

FIG. 47 shows a flow diagram of one embodiment of a process according tothe teachings of the present invention;

FIG. 48 shows an example of one embodiment of a search index requestview (UI); and

FIG. 49 illustrates a flow diagram of one embodiment of a process forremote client search indexing in accordance with the teachings of thepresent invention.

DETAILED DESCRIPTION

In the following detailed description numerous specific details are setforth in order to provide a thorough understanding of the presentinvention. However, it will be appreciated by one skilled in the artthat the present invention may be understood and practiced without thesespecific details.

I. System Overview and Overall Architecture

In one embodiment, a system in which the teachings of the presentinvention are implemented can be logically structured as a multi-layeredarchitecture as shown in FIG. 1. In one embodiment, the logicalmulti-layered architecture as shown in FIG. 1 provides a platform forcommon services to support the various applications. These services mayinclude a user interface layer 110, an object manager layer 120, a datamanager layer 130, and a data exchange layer 140.

In one embodiment, the user Interface layer 110 may provide the applets,views, charts and reports, etc. associated with one or moreapplications. In one embodiment, various types of clients can besupported via the user interface layer 110. These various types ofclients may include traditional connected clients, remote clients, thinclients over an intranet, Java thin clients or non-Windows-basedoperating systems, and HTML clients over the Internet, etc.

In one embodiment, the object manager layer 120 is designed to manageone or more sets of business rules or business concepts associated withone or more applications and to provide the interface between the userinterface layer 110 and the data manager layer 130. In one embodiment,the business rules or concepts can be represented as business objects.In one embodiment, the business objects may be designed as configurablesoftware representations of the various business rules or concepts suchas accounts, contacts, opportunities, service requests, solutions, etc.

In one embodiment, the data manager layer 130 is designed to maintainlogical views of the underlying data and to allow the object manager tofunction independently of underlying data structures or tables in whichdata are stored. In one embodiment, the data manager 130 may alsoprovide certain database query functions such as generation of structurequery language (SQL) in real time to access the data. In one embodiment,the data manager 130 is designed to operate on object definitions in arepository file 160 that define the database schema. In one embodiment,the data storage services 170 provide the data storage for the datamodel associated with one or more applications.

In one embodiment, the data exchange layer is designed to handle theinteractions with one or more specific target databases and provide theinterface between the data manager layer 130 and the underlying datasources.

FIG. 2 shows the various system components that may be included in themulti-layered system architecture illustrated in FIG. 1.

In one embodiment, the multi-layered architecture allows one or moresoftware layers to reside on different machines. For example, in oneembodiment, the user interface, the object manager, and the data managercan all reside on the connected and mobile clients. For thin clients, inone embodiment, the object manager and data manager can reside on asystem server. As another example, the user interface resides on asystem server for HTML clients. It should be appreciated and understoodby one skilled in the art that the system configuration shown in FIG. 2is for illustrative and explanative purposes and may vary depending uponthe particular implementations and applications of the teachings of thepresent invention.

In one embodiment, the system environment illustrated in FIG. 2 mayinclude more than one database 290. One or more subsets of the database290 can be created or replicated by a replication manager. In addition,mobile clients can have additional remote databases (also called localdatabases). In one embodiment, unless the remote or local databasesassociated with the mobile clients are defined as read-only databases,these mobile clients can create and update data locally that will beultimately propagated up to the primary database when each mobile clientsynchronizes with the system server.

In one embodiment, the database 290 is designed to store various typesof data including predefined data schema (e.g., table objects, indexobjects, etc.), repository objects (e.g., business objects andcomponents, view definitions and visibility rules, etc.), and user's orcustomer's data. In one embodiment, connected clients and servercomponents, including those that operate in conjunction with the thinclients, can connect directly to the database 290 and make changes inreal time. In one embodiment, mobile clients can download a subset ofthe server's data to use locally, and periodically synchronize with theserver database through the system server to update both the local andthe server database.

In one embodiment, the file system 295 is a network-accessible directorythat can be located on an application server. In one embodiment, thefile system 295 stores the physical files created by variousapplications, such as files created by third-party text editors, andother data that is not stored in the database 290. In one embodiment,physical files stored in the file system 295 can be compressed andstored under various naming conventions. In one embodiment, connectedclients read and write files directly to and from the file system 295.In one embodiment, mobile clients can have a local file system, whichthey synchronize with the server-based file system 290 periodically. Inone embodiment, thin clients access the file system 290 via the systemserver.

In one embodiment, the enterprise server 250 is a logical grouping ofthe system servers 255 that share a common table owner or a database,point to a common gateway Server, and can be administered as a groupusing server manager 260. In one embodiment, the connection to thegateway server can be established via TCP/IP. In one embodiment, theenterprise server 250 can be scaled effectively by deploying multiplesystem servers 255 in the enterprise server 250, thus providing a highdegree of scalability in the middle tier of applications.

In one embodiment, the server 255 runs one or multiple server programs.It handles the incoming processing requests and monitors the state ofall processes on the server. In one embodiment, server programs aredesigned and configured to perform one or more specific functions orjobs including importing and exporting data, configuring the database,executing workflow and process automation, processing to support mobileclients for data synchronization and replication, and enforcing businessrules, etc. In one embodiment, the server 255 can be an NT Service(under Windows NT operating system) or a daemon (e.g., a backgroundshell process) under UNIX operating system. In one embodiment, theserver 255 supports both multi-process and multi-threaded components andcan operate components in batch, service, and interactive modes.

In one embodiment, the server manager is configured as a utility thatallows common control, administration and monitoring across disparateprograms for the servers 255 and the enterprise server 250. In oneembodiment, the server manager can be used to perform the followingtasks: start, stop, pause, and resume servers 255, components, andtasks; monitor status and collect statistics for multiple tasks,components, and servers within an enterprise server; and configure theenterprise server, individual servers individual components, and tasks,etc.

In one embodiment, the gateway server can be configured as a logicalentity that serves as a single entry point for accessing servers. In oneembodiment, it can be used to provide enhanced scalability, loadbalancing and high availability across the enterprise server. In oneembodiment, the gateway server may include a name server and aconnection brokering component. In one embodiment, the name server isconfigured to keep track of the parameters associated with the servers.For example, the availability and connectivity information associatedwith the servers can be stored in the name server. The variouscomponents in the system can query the name server for variousinformation regarding the servers' availability and connectivity. In aWindows NT environment, the name server can be run as a NT service. In aUNIX environment, the name server can run as a daemon process. In oneembodiment, the connection brokering component is used to perform loadbalancing function such as directing client connection requests to anappropriate server (e.g., the least-busy server).

In one embodiment, as illustrated in FIG. 2, the various types ofclients that can be supported by the system included the followingclients: connected clients, mobile clients, HTML thin clients, wirelessclients, thin clients for Windows, and Java thin clients, etc.

In one embodiment, connected (also called dedicated) clients areconnected directly to a database server for data access via a LAN or WANconnection. In one embodiment, these connected or dedicated clients donot store data locally. These connected clients can also access the filesystem directly. In one embodiment, the mobile clients are designed andconfigured for local data access and thus can have their own localdatabase and/or local file system. In one embodiment, mobile clients caninteract with other components within the system via the gateway server.Through synchronization, the modifications from the local database andthe server database can be exchanged.

In one embodiment, HTML thin clients may include a set of componentsused to customize and implement web-based applications. These HTML thinclients, in one embodiment, are part of a larger system configurationthat may include a server, a database, and a web server, etc. The majorcomponents of a HTML thin client system configuration are shown in FIG.3 that include a web application, a web server extension, a web engine,and various templates. In one embodiment, wireless clients areessentially thin clients enabled on wireless devices. The wirelessclients can use a wireless application protocol (WAP)-based userinterface to communicate and exchange information/data with the systemserver. In one embodiment, the windows thin clients and the Java thinclients can access the applications dynamically over the network frommachines that are connected to the system. The system is described inmore details below with references to various databases, tables, filesystems, etc. as illustrating examples.

II. eSearch Application/System and Related System Components:

FIG. 4 illustrates an exemplary Search Tool Bar 400 in accordance withone embodiment of the present invention. In this embodiment, Search ToolBar 400 includes a dropdown list 405, an Edit button 410, and a SearchIcon 405. From the dropdown list 405, the user can select an item fromthe list to populate the content area or the Search Frame. Additionaldetails regarding the Content Area Frame and the Search Frame areprovided below in FIG. 5 and the text describing the figure.

Edit button 410 is typically used to open the Search Frame to allow theuser to modify or delete items in the dropdown list 405. Search Icon 410is generally used to open the Search Center Frame or Pane. Additionaldetails on the Search Center Frame or Pane are provided below in FIG. 5and the text describing the figure.

FIG. 5 illustrates an exemplary Search Center Frame or Pane 500 inaccordance with one embodiment of the present invention. Search CenterFrame or Pane 500 includes a Tool Bar section 505, a Content Area Frame510, a Search Frame 515, and a Results Frame 520. Search Tool Bar 400(shown in FIG. 4) remains in the Tool Bar section 505. Content AreaFrame 510 is generally used to display the content of a selected searchresult available from the search. Search Frame 515 will be explained inmore details below in FIGS. 24 and 25 and the text describing thefigures. Results Frame 520 is typically used to display a list of searchresults available from the search.

Search Objects

Prior to performing a search, certain Search objects may need to beconfigured or created. FIG. 6 is a flow chart generally outlining anexemplary process 600 of creating various Search objects. The exemplaryprocess can include the following actions:

-   -   Creating one or more Search Engine objects if a Search Engine        object does not already exist (block 610);    -   Creating one or more Search Index objects and associate the        created Search Index objects to one or more Business Component        objects (block 615);    -   Creating one or more Search Category objects and associate the        created Search Category objects to a Search Index object (block        620); and    -   Creating one or more Search Definition objects (block 625). It        should be noted each Search Definition object represents a group        of one or more Search Category objects created in block 629.

Each of the aforementioned actions will be described below in moredetails.

Search Engine

FIG. 7 is a flow chart generally outlining an exemplary process 700 ofcreating a Search Engine object in accordance with one embodiment of thepresent invention. Creating each Search Engine object can generallyinclude defining a Search Engine object (block 710) and creating orconfiguring Result Fields associated with the defined Search Engineobject (block 715).

FIG. 8 generally illustrates properties of a Search Engine object 800 inaccordance with one embodiment of the present invention. In thisembodiment, the Search Engine object 800 generally represents a SearchEngine and can include two properties: Name 805 and Class 810. Name 805generally refers to the name of a Search Engine, e.g., “Fulcrum”. Class810 generally refers to the class name of a Search Adapter associatedwith the named Search Engine.

Each Search Engine has a default set of Result Fields related to it.Additional Result Fields may be created and added to the default set ofResult Fields. A Result Field object is generally used to associate aResult Field with each Search Engine. In one embodiment, each ResultField object operates under the following rules and assumptions. First,the defined Result Field is generally created for the Search Tablesbelonging to the parent Search Engine object or the Search Engine towhich the Result Field relates. Second, some of the defined Result Fieldcan be customized per search definition. A description of Custom ResultFields, which are used to customize Result Fields per search definition,will be provided below.

FIG. 9 generally illustrates properties of an exemplary Result Fieldobject 900 in accordance with one embodiment of the present invention.In this embodiment, the Result Field object 900 can include thefollowing properties: Column Name 905, Create Column Flag 910, Data Type915, Index Mode 920, Name 925, Text Length 930, and Type 935.Accordingly, creating a Result Field object 900 involves defining someor all of the aforementioned properties. Of the aforementionedproperties of the Result Field object 900, Column Name 905, Name 925,and Type 935 are required properties; and Create Column Flag 910, DataType 915, Index Mode 920, and Text Length 930 are optional properties.

Column Name 905 is generally the name of the physical column in a SearchIndex. Column Name 905 may differ for different types of databasesoftware. Name 925 is generally a logical name of the Result Field. Type935 represents a pick list displaying valid values. Create Column Flag910 denotes whether a column needs to be explicitly created by the user.Data Type 915 specifies a data type of a column. Exemplary values for aData Type 915 may include “varchar”, “character”, and “apvarchar”. IndexMode 920 specifies the index mode of a column. Exemplary values for anIndex Mode 920 may include “literal”, “none”, and “normal”. Text Length930 specifies the amount of storage bytes that should be allocated forthe Result Field.

Search Index

FIG. 10 is a flow chart generally outlining an exemplary process 1000 ofcreating a Search Index object in accordance with one embodiment of thepresent invention. Creating each Search Index object can includedefining a Search Index object (block 1010), creating a Search Tableobject for the defined Search Index object (block 1015), creating one ormore Index Field objects for the created Search Table object (block1020), and creating one or more Filter Field objects for the createdSearch Table object (block 1025). Defining each Search Index object(block 1010) can include identifying or more Business Components thatneed to be indexed by a selected Search Engine and creating a SearchIndex object and associate the created Search Index object to eachidentified Business Component.

FIG. 11 generally illustrates properties of an exemplary Search Indexobject 1100 in accordance with one embodiment of the present invention.As shown in the figure, each Search Index object 1100 can have thefollowing properties: Name 1105, Index Business Component 1110, andDatabase Table Flag 1115. Name 1105 includes the logical name of theSearch Index object 1100, and is a required property. Index BusinessComponent 1110 and Database Table Flag 1115 are optional fields. IndexBusiness Component 1110 is generally a Business Component to which theSearch Index object 1100 maps. It should be noted that the IndexBusiness Component 1110 can be null if the Business Component is basedon an external directory. Database Table Flag 1115 generally indicateswhether the Search Index object 1100 maps to a physical database table.

Creating and configuring each Search Table object for each definedSearch Index object (block 1015 of FIG. 10) generally involvesassociating the Search Index to a physical index table or collectionthat is in a selected Search Engine and that physically represents theSearch Index. FIG. 12 generally illustrates properties of an exemplarySearch Table object 1200 in accordance with one embodiment of thepresent invention. In one embodiment, the Search Table object 1200 canhave the following required properties: Table Name 1205 and Engine 1210.Table Name 1205 generally specifies the actual name of the physicalindex table or collection that physically represents the Search Index.Engine 1210 includes the name of the selected Search Engine, e.g.“Fulcrum”.

FIG. 13 is a flow chart generally outlining an exemplary process 1300 ofcreating an Index Field Map object for each created Search Table inaccordance with one embodiment of the present invention. Index Field Mapobject generally denotes the Business Component Fields that need to beindexed into the Search Index. In one embodiment, Index Field Map objectcan be generally used to map the Business Component Fields to ResultFields associated to the Search Engine, which is created as described inFIG. 7. The process 1300 of creating and configuring each Index FieldMap object for each created Search Table object generally involvesselecting a desired Business Component (block 1310), mapping theselected Business Component to a Result Field (block 1320), and choosingthe Index Field Type 1325.

It should be noted that Index Field Type 1325 can specify a fileattachment denoting that a full-text search is to be performed on one ormore attached documents or files. In other words, if Index Field Type1325 specifies a file attachment, a full-text search will be performedon the one or more attached files denoted by the file attachment.

FIG. 14A generally illustrates properties of an exemplary Index Fieldobject 1400 in accordance with one embodiment of the present invention.In this embodiment, the Index Field object 1400 can include thefollowing properties: Business Component Field 1410, Result Field 1415,Index Field Type 1420, and Sequence 1425. Of the aforementionedproperties, Name 1405, Business Component Field 1410, and Sequence 1425are required; and Result Field 1415 and Index Field Type 1420 areoptional. Business Component Field 1410 generally represents the activefields of the applet or Business Component associated with the parentSearch Index object. It should be noted that the active field will beincluded in a selected Search action. Sequence 1425 is generally thesequence in which Business Component Fields are read from the databasetable. Result Field 1415 represents the result to which the Index Fieldmaps. Index Field Type 1420 specifies the type of the Business Componentidentified in the Business Component Field 1410. Exemplary values ofIndex Field Type 1420 can include “Row Id”, “Group”, “Attachment”,“Revision Number”, “Organizational Visibility”, and “Group Visibility”.The information provided in Index Field Type 1420 will be used atruntime to do some special processing. For example, the BusinessComponent Field Id usually holds the Row Id for each row in the databasetable. Therefore, specifying an Index Field Type of “Row Id” wouldidentify the values in the indexed column as being identifications ofrows and hence can be used for easy retrieval and processing.

Creating or configuring a Filter Field object generally involvesidentifying and defining the fields of the Business Component that areto be indexed into the parent Search Table separately and in addition tothe Result Fields. In other words, each Search Table will inherit themandatory set of Result Fields defined for a selected Search Engine plusFilter Fields defined for the Search Table. In general, Filter Fieldobjects generally define Filter Fields which are used to constrainresults of searches. These Filter Fields typically are indexed into theSearch Table as defined by the Search Table object.

FIG. 14B generally illustrates properties of an exemplary Filter Fieldobject 1450 in accordance with one embodiment of the present invention.In this embodiment, a Filter Field object 1450 can include the followingproperties: Name 1455, Column Name 1460, Data Type 1465, Index Mode1470, Sequence 1475, and Text Length 1480. Of the aforementionedproperties, Name 1455, Column Name 1460, and Sequence 1475 are required;and Data Type 1465, Index Mode 1470, and Text Length 1480 are optional.Name 1455 generally represents the active fields of the BusinessComponent associated with the parent Search Index object. Column Name1460 is the name of the physical column of the parent Search Index. Itshould be noted that Column Name 1460 can vary with different types ofdatabase software. Sequence 1475 generally denotes the sequence in whichthe Filter Fields are created. Data Type 1465 specifies the data type ofthe physical column. Exemplary values of Data Type 1465 can include“varchar” and “char”. Index Mode 1470 specifies the index mode of thephysical column. Examples of values of Index Mode 1470 can include“literal”, “none”, and “normal”. Text Length 1480 represents the amountof storage in bytes allocated to the Filter Field that is being created.

Search Category

FIG. 15 is a flow chart generally outlining an exemplary process 1500 ofcreating and configuring a Search Category object. The creating andconfiguring of a Search Category object can include defining a SearchCategory (block 1510) and associating the defined Search Category to aSearch Index (block 1515). The creating and configuring of a SearchCategory can further include defining a Drilldown View, a DrilldownBusiness Component, and a Destination Field to be used when navigatingsearch results pertaining to the defined Search Category (block 1520).The creating and configuring of a Search Category can also includedefining a Pick View capable of receiving search results as anattachment (block 1525).

Each Search Category object generally represents a Search Categoryagainst which a search can be performed. It should be noted that eachSearch Category object generally maps to a Search Index object. Itshould also be noted that a particular Search Index object can beassociated or can relate to one or more Search Category objects.

FIG. 16 generally illustrates properties of an exemplary Search Categoryobject 1600 in accordance with one embodiment of the present invention.In this embodiment, each Search Category object 1600 includes thefollowing properties: Name 1605, Search Index 1610, Drilldown BusinessComponent 1615, Drilldown View 1620, and Result Identifier 1625. Of theaforementioned properties, Name 1605 and Search Index 1610 are required;and Drilldown Business Component 1615, Drilldown View 1620, and ResultIdentifier 1625 are optional. Name 1605 generally represents the logicalname for the Search Category. Search Index 1610 is generally theidentity of the Search Index object to which the Search Categoryassociates. Drilldown Business Component 1615 represents the destinationbusiness component into which the user is drilling. Drilldown View 1620is generally the view that appears when the user drills down. ResultIdentifier 1625 generally represents an acronym that is used in theSummary column in a Search Result.

Using Search Category objects, users can define several SearchCategories based on the same Search Index so that different DrilldownViews and Pick Views can be defined. As examples, a Solution Call Centercategory can drill down to a Solution Resolution Documents View, and theSolution eService Category can drill down to a Solution ResolutioneService View. Furthermore, Pick Views can be defined differently fordifferent Search Categories.

Creating one or more Pick View objects for a parent Search Categoryobject generally includes identifying applets to which the SearchResults can be associated. FIG. 17 generally illustrates properties ofan exemplary Pick View object 1700 in accordance with one embodiment ofthe present invention. In this embodiment, each Pick View object 1700can include the following properties: Applet 1705, View 1710, Name 1715,and Destination Field 1720. Of the aforementioned properties, Applet1705, View 1710, and Name 1715 are required; and Destination Field 1720is optional. Applet 1705 generally represents the name of an applet thatcan receive selected Search Results. View 1710 is generally the name ofthe view containing the Applet 1705. Name 1715 generally represents thelogical name the Pick View. Destination Field 1720 is generally the nameof a field designated to receive the selected Search Results.

Search Definition

FIG. 18A is a flow chart generally outlining an exemplary process 1800of creating and configuring a Search Definition object. Creating aSearch Definition object generally includes specifying a name for theSearch Definition (block 1810), and providing a specification forsorting Search Results (block 1815). A Search Definition is generally agrouping of Search Categories. Users can typically define one or moreSearch Definitions for an application. After the Search Definitionobject is created, one or more Search Category objects can be associatedwith the Search Definition object (block 1820). In one embodiment, aSearch Category object associated with a parent Search Definitionincludes different properties than a Search Category associated with aSearch Index. In addition, one or more Custom Result Fields objects canbe created for the Search Definition object (block 1825).

FIG. 18B generally illustrates properties of a Search Definition object1850 in accordance with one embodiment of the present invention. In thisembodiment, Search Definition object 1850 can include the followingproperties: Name 1855 and Sort Specification 1860. Name 1855 is arequired property, while Sort Specification 1860 is an optionalproperty. Name 1855 generally represents a logical name of the SearchDefinition. Sort Specification 1860 is generally a sort expression usedto order returned records. Exemplary values for Sort Specification 1860can include “SCORE DESC” and “FILENAME ASC”.

FIG. 19 generally illustrates properties of an exemplary Search Categoryobject 1900 associated with a Search Definition in accordance with oneembodiment of the present invention. In this embodiment, Search Categoryobject 1900 associated with the Search Definition can include thefollowing properties: Name 1905, Display Name 1910, Filter SearchSpecification 1915, Use Filtered Search 1920, and Sequence 1925. Of theaforementioned properties, Name 1905 and Display Name 1910 are required;and Filter Search Specification 1915, Use Filtered Search 1920, andSequence 1925 are optional. Name 1905 generally identifies the SearchCategory. Display Name 1910 generally represents the actual display nameof the Search Category. In one embodiment, Display Name 1910 appears inthe category dropdown field in the Basic Search applet or the AdvancedSearch applet. Filter Search Specification 1915 applies to filterfields. Use Filtered Search 1920 should be set to TRUE if filteredsearch is to be applied on the Search Category. Sequence 1925 generallyspecifies the order in which Search Categories are listed in the searchapplet for the parent application.

Creating one or more Custom Result Field objects for a parent SearchDefinition object generally includes specifying the search execution ordisplay properties for the result fields. FIG. 20 generally illustratesproperties of an exemplary Custom Result Field object 2000 in accordancewith one embodiment of the present invention. In this embodiment, CustomResult Field object 2000 can include the following properties: DisplayName 2005, Display Format 2010, Name 2015, Scaling Factor 2020, Sequence2025, Text Alignment 2030, Use in Search 2035, Visible 2040, and Width2045. Of the aforementioned properties, Name 2015 and Sequence 2025 arerequired. Name 2015 generally represents the logical name of the CustomResult Field. Sequence 2025 generally specifies the order in whichcolumns should appear. Display Name 2005, Display Format 2010, ScalingFactor 2020, Text Alignment 2030, Use in Search 2035, Visible 2040, andWidth 2045 are optional properties. Display Name 2005 is the name todisplay in the user interface. Display Format 2010 generally indicates aformat mask to apply to data. Scaling Factor 2020 generally represents amultiplication factor for numeric columns. Text Alignment 2030 generallyspecifies the alignment of the text in the column. Use in Search 2035generally indicates whether the column is to be included in a search.Visible 2040 can be set to TRUE if the Custom Result Field is to bedisplayed. Width 2045 generally specifies the width of the displaycolumn in pixels.

FIG. 21 shows a summary of the relationship between these exemplarySearch objects described above. As shown in the figure, an object canhave a 1:1 relationship to another object. For example, there is a 1:1relationship between a Search Category object and a Drilldown Viewobject. In addition, an object can have a 1:M relationship to anotherobject. For example, there can be many Search Definition objects thatare related or associated to a Search Engine object.

Search Administration

Search Administration is generally a common tool for creating andadministrating Search Indices for a selected search engine (e.g.,Fulcrum). In one embodiment, the creating and administrating SearchIndices encompasses two main areas, including Search IndicesAdministration for administrating table and indices (e.g., creation,indexing, refreshing, etc.) and Search Settings Administration forsetting search properties that are used throughout the search process.

Search Indices Administration

To begin the process of administrating Search Indices, the user oradministrator navigates to the Search Indices View. FIG. 30 illustratesan exemplary Search Indices View 3000 in accordance with one embodimentof the present invention. The user or administrator can generally usethe Search Indices View to create new indices, refresh selected existingindices, and refresh all existing indices. Search Indices View includestwo applets, Search Administration Settings List Applet 3005 and SearchIndex List Applet 3010. Search Administration Settings List Applet 3005is displayed at the top of the Search Indices View 3000. SearchAdministration Settings List Applet 3005 can generally be used todisplay and manipulate existing administrative settings, or create newadministrative settings.

Search Index List Applet 3010 is displayed at the bottom of the SearchIndices View 3000. In one embodiment, Search Index List Applet 3010 isimplemented as a read-only applet. Search Index List Applet 3010generally displays a list of all available Search Index objects. Adescription of a Search Index object is provided above in the SearchObjects section. In one embodiment, Search Index List Applet supports anumber of methods, including Index, Refresh, and Refresh-All. Index cangenerally be used to create a new search index. Refresh can generally beused to re-index a selected search index. Refresh-All can generally beused to re-index all valid and existing search indices.

Search Settings Administration

The administration of search settings can be divided into two mainareas, including Search Execution Settings to configure run-timeproperties and Search Administration Settings to configure propertiesused during the L administration or creation of Search Indices.

FIG. 31 shows an exemplary Search Execution Settings View 3100 inaccordance with one embodiment of the present invention. SearchExecution Settings View 3100 includes two applets, Search Settings ListApplet 3105 and Search Settings Properties List Applet 3110. The user oradministrator generally utilizes the Search Execution Settings View 3100to define properties for a selected search engine (e.g., Fulcrum). Theproperties are listed as name-value pairs and are applied to searchesdone against a given database using the selected search engine.

Search Settings List Applet 3105 is displayed at the top of the SearchExecution Settings View 3100. Search Settings List Applet 3105 generallyshows a list of available settings. Search Settings Properties ListApplet 3105 is displayed at the bottom of the Search Execution SettingsView 3100. Search Settings Properties List Applet 3105 generally shows alist of basic and advanced search execution properties. Exemplaryproperties can include values for synonym searching, word stemming,spell checking, and relevance ranking.

FIG. 32 shows an exemplary Search Administration Settings View 3200 inaccordance with one embodiment of the present invention. SearchAdministration Settings View includes two applets, Search Admin SettingsList Applet 3205 and Search Admin Settings Properties List Applet 3210.The user or administrator generally uses Search Administration SettingsView 3200 to define search administration settings and properties.Search Admin Settings List Applet 3205 is displayed at the top of theSearch Administration Settings View 3200. Search Admin Settings ListApplet 3205 generally shows a list of available settings. Search AdminSettings Properties List Applet 3210 is displayed at the bottom of theSearch Administration Settings View 3200. Search Admin SettingsProperties List Applet 3210 generally shows a list of searchadministration properties. An exemplary search administration propertyis “Character Set” 3215, which can be set to “WIN_LATIN1” 3220.“WIN_LATIN1” 3220 denotes that while creating an index, the selectedsearch engine could expect characters of type Latin1.

Search Execution

FIG. 22 is a flow chart generally outlining an exemplary process 2200 ofhow a search is executed in accordance with one embodiment of thepresent invention. FIG. 23 illustrates a block diagram of a system 2300in accordance with one embodiment of the present invention. As statedabove, the system will be described below with references to variousdatabases, tables, file systems, etc. as illustrating examples. However,it should be understood by one skilled in the art that the teachings ofthe invention should be applicable to other types of databases, tables,file systems, etc. It should further be noted that the description ofthe process below will be done with references to FIGS. 22 and 23.

To perform a search, a user generally selects or specifies searchcriteria through the Search Center User Interface. In one embodiment,the search criteria may include a Search Category and a search text orkeyword. It should be noted that the user can select multiple SearchCategories at the same time. Search Category objects representing SearchCategories can be created and associated with Search Indices or SearchDefinitions, as described above in the Search Objects section. After theuser selects a Search Category (or Search Categories) and enters asearch text or keyword, the user would then select the Search button toexecute the search. In block 2210 of FIG. 22, the user-selected SearchCategory and the user-entered search text or keyword are received.

In block 2215 of FIG. 22, the selected Search Category and the searchtext or keyword are passed to a Search Execution Virtual BusinessComponent (VBC) 2305 (shown in FIG. 23). A Virtual Business Component2305,2310 (shown in FIG. 23) generally represents external data as abusiness component, which generally provides a layer of wrapping overdatabase tables. By using Virtual Business Components 2305,2310,external data (e.g., data in an Oracle database or a SAP R/3 database)can be represented. Furthermore, business services can be used totransfer data. As a result, duplication of data can be avoided, and aunified presentation of legacy and non-legacy data can be achieved.

Once the Search Category or Categories and the search text or keywordare passed to the Search Execution VBC 2305 (shown in FIG. 23), the VBC2305 invokes a registered business service called the Search ExecutionService 2315 and passes along the Search Category or Categories and thesearch text or keyword as parameters (block 2220 of FIG. 22). A businessservice 2315,2320,2325,2330 (shown in FIG. 23) is generally an objectencapsulating and simplifying the use of a set of functionalities.Business component objects are typically tied to specific data andtables. On the other hand, business services 2315,2320,2325,2330 are nottied to specific data and tables. Rather, business services2315,2320,2325,2330 operate or act upon objects to achieve a particulargoal. Business services 2315,2320,2325,2330 are generally used tosimplify the task of moving data and converting data formats betweenapplications.

Business services 2315,2320,2325,2330 use property sets for input andoutput. A property set is generally a hierarchical data structure thatcan include name-value pairs. An example of a name-value pair can be(FontColor=Green), where FontColor is a property and the name-value pairsets the value of the FontColor property to the value of Green. Aproperty set can also include one or more child property sets. Eachchild property set can in turn include one or more grandchildrenproperty sets.

Once the user performs a search to generate Search Results, these SearchResults are persistent for a user session. In other words, the contentof the Search Results are cached and saved until the user session isterminated (block 2225 of FIG. 22). Accordingly, the user can retrieveand use the generated Search Results within a user session.

The persistency of the Search Results allows the user to perform certainactions on the Search Results. As an example, the user can furtherrefine a search. For example, assuming that the user performs a searchon the keyword “modem” and receives Search Results relating to “modem”.The user then realizes that she was really looking for “58 K modems”.The user could perform a refined search on the Search Results for “58 Kmodems.” Additional details on refining a search will be provided below.

As another example of the usefulness of the persistency of SearchResults, the user can preview the Search Results. When the user receivesSearch Results generated from a search, the user could select the“Preview” button to view a selected Search Result record in a popupview. By previewing the Search Result record in the popup view, the userdoes not have to use the current window generated by the client. Theuser essentially has and can look at two separate views, including awindow generated by the client and a popup view displaying the previewof a Search Result record. Additional details on previewing SearchResults will be provided below.

As an additional example of the usefulness of the Search Resultspersistency, the user can attach Search Results to another object. Atypical scenario in which attaching Search Results is useful would be auser trying to resolve a current service request. In this scenario, theuser would begin by performing a search for existing “Solutions”. Afterthe prior solutions resulting from the search are available, the usercan then go through the solutions to find an appropriate solution forthe current service request. Once the appropriate solution is found, theuser can select the “Attach” button to attach the appropriate solutionto the current service request. Additional details on attaching SearchResults will be provided below.

In one embodiment, a cached Business Service is employed to supportpersistent Search Results. The cached Business Service employed toexecute searches is called the Search Execution Business Service. Oncethe search center is opened or a search is started from the searchtoolbar, an instance of a cached Business Service in general (and SearchExecution Business in particular) is invoked. The invoked BusinessService instance will generally remain in existence until the usersession is terminated. In other words, the invoked Business Serviceinstance maintains information about the executed search (e.g., SearchCategories and search text or keyword) until the user sessionterminates. As examples, the user session can terminate when the usersigns off or times out.

In one embodiment, the component that determines the begin or end of auser session is the Application Object Manager 120 (shown in FIG. 1).From a system management point of view, a session begins when the clientconnects to the Application Object Manager 120, and ends when theconnection is terminated. In an embodiment where multi-tasking issupported, a task is started on the Application Object Manager tosupport a user session. In an embodiment where multi-threading issupported, a thread is started on the Application Object Manager tosupport a user session.

As stated above, the Business Service used to perform searches is calledthe Search Execution Service 2315 (shown in FIG. 23). In one embodiment,the Search Execution Service 2315 supports the following externalinterfaces: ::SetSearchParameters, ::ExecuteSearch, ::IsSearchExecuted,::GetNumberOfResults, ::GetResultFields, and ::GetResultFieldvalues. Inone embodiment, ::SetSearchParameters generally receives searchparameters such as Search Categories and the search text or keyword andsaves the received search parameters in data structures internal to theSearch Execution Service 2315. It should be noted that externalinterfaces supported by the Search Execution Service 2315 are invoked byobjects that are external to the Search Execution Service 2315, e.g.,the Search Execution Virtual Business Component 2305. ::ExecuteSearchgenerally performs the search using the selected search adapter. Forexample, if the Fulcrum Search Engine 2340 is selected, ::ExecuteSearchwould start the search adapter for Fulcrum and would use the Fulcrumsearch adapter to perform the search. ::IsSearchExecuted generallychecks whether the search was executed or performed.::GetNumberOfResults generally returns the number of results availablefrom executing or performing the search. ::GetResultFields generallyreturns the result fields that need to be displayed on a particularsearch result row. In one embodiment, the result fields are generateddynamically during runtime. ::GetResultFieldValues is generally used toretrieve the values of the result fields.

In one embodiment, the Search Execution Service 2315 also support someinternal interfaces, including ::CreateSearchAdapter and::InitializeSearchAdapter. It should be noted that external interfacessupported by the Search Execution Service 2315 can only be invoked bycomponents that are internal to the Search Execution Service.::CreateSearchAdapter generally selects the search engine to be used byexamining configuration information and dynamically invokes the searchadapter appropriate for the search engine. ::InitializeSearchAdapter isgenerally used to initialize the invoked search adapter.

In one embodiment, search adapter classes can be derived from thegeneric base class CSSSearchAdapter 2335. CSSSearchAdapter 2335 supportsinterfaces that are common to search engines 2340,2345,2350. In thisembodiment, the interfaces supported by CSSSearchAdapter 2335 can begrouped in the following categories: interfaces for initializing thesearch engine, interfaces for executing or performing the search,interfaces for allocating buffers to store results of the search if thesearch is successful, interfaces for filling the allocated buffers withresults of the search, and interfaces for error handling. Interfaces forexecuting or performing the search can include methods for parsingsearch keywords, methods for parsing filter search specifications, andmethods for constructing Visibility queries. Additional details onVisibility will be provided below.

Interfaces for initializing the search engine can include methods forinitializing results buffers, methods for initializing Search Categoriesbuffers, and methods for initializing Filter Field buffers. A resultsbuffer generally holds results that the search engine generates for asearch. In one embodiment, the results buffer includes an array ofsearch result rows. Each search result row is stored in a Result Row.Accordingly, the Result Row contains values for one search result row.These values are stored in a hash table of name-value pairs. Forexample, a Result Row can include the following fields: RowId, Summary,Relevance, and File Size. Exemplary values for the aforementioned fieldscan be “10-2344 A”, “How to create a Service Request”, “90%”, and “150KB” respectively.

Result Field Information is generally a data structure that is used forcaching definitions of the result fields for the currently selectedsearch engine. In one embodiment, these definitions of the result fieldsare cached once every user session. Each result field is generally anabstraction of the actual physical column in the table pertaining to thecurrently selected search engine (e.g., Fulcrum).

Each Result Field Information data structure can generally includefields that store information that can be used while constructingqueries to be executed by the currently selected search engine or whiledisplaying results available for the search. Accordingly, each ResultField Information data structure can contain fields pertaining to userinterface (UI) functions or non-UI functions.

In one embodiment, fields in the Result Field Information data structurethat can be used while constructing queries (i.e., non UI functions) caninclude Name, Column Name, Data Type, Index Mode, and Text Length. Namegenerally represents the name of the result field. Column Name generallyholds the name of the physical column in the table pertaining to thecurrently selected search engine (e.g., Fulcrum). Data Type generallyspecifies the data type of the result field. Exemplary values for DataType can include “varchar”, “character”, and “apvarchar”. Index Modespecifies the index mode of a column. Exemplary values for Index Modecan include “normal”, “literal”, or “none”.

In one embodiment, fields in the Result Field Information data structurethat can be used while displaying results (i.e., UI functions) caninclude Display Name, Text Alignment, and Visible. Display Namegenerally contains a label that is to be displayed on the user interface(UI). Text Alignment generally represents the alignment that is to beemployed when displaying the value of the result. Exemplary values forText Alignment can include “left”, “center”, and “right”. Visible isgenerally a boolean flag which should be set to TRUE if the result fieldshould be displayed and FALSE if the result field should not bedisplayed.

Search Categories buffers are generally used to hold Search CategoryInformation data structures. Each Search Category Information datastructure is generally used to cache all the information pertaining to aSearch Category on which a search can be performed for the currentapplication.

Each Search Category Information data structure can generally includefields that store information that can be used while constructingqueries to be executed by the currently selected search engine or whiledisplaying results available for the search. Accordingly, each ResultField Information data structure can contain fields pertaining to userinterface (UI) functions or non-UI functions.

In one embodiment, fields in the Search Category Information datastructure that can be used while constructing queries (i.e., non UIfunctions) can include Name, Index Name, Table Name, Filter Field ObjectArray. Name generally represents the name of a Search Category. IndexName is generally the name of the underlying Search Index. It should benoted that many Search Categories can be associated to the same SearchIndex. As a result, users of various applications can customize SearchCategories to fit the users' needs based on their application. TableName generally represents the name of the underlying table correspondingto the Search Index. Filter Field Object Array generally holds one ormore Filter Field objects. Each Filter Field object represents a FilterField, which is generally used to constrain or restrict a search.

In one embodiment, fields in the Search Category information datastructure that can be used while displaying results (i.e., UI functions)can include Display Name, Drilldown View, and Drilldown BusinessComponent. Display Name is generally a label that is to be displayed onthe UI. Drilldown View generally represents a view to which the userwill be navigated when the results available from the search aredisplayed. When the view specified in Drilldown View is displayed, theview typically includes various Business Components. Drilldown BusinessComponent generally represents the Business Component to which the usershould be navigated when results available from the search are displayedwithin the view specified in Drilldown View.

Filter Field Information is generally a data structure used to cache thedefinition of a Filter Field defined for a particular Search Index. EachFilter Field Information data structure can include the followingfields: Name, Column Name, Data Type, Index Mode, and Text Length. Namegenerally represents the name of the result field. Column Name generallyholds the name of the physical column in the table pertaining to thecurrently selected search engine (e.g., Fulcrum). Data Type generallyspecifies the data type of the result field. Exemplary values for DataType can include “varchar”, “character”, and “apvarchar”. Index Modespecifies the index mode of a column. Exemplary values for Index Modecan include “normal”, “literal”, or “none”.

Once the appropriate search adapter is invoked or started, default basicand advanced search settings for the selected search engine (e.g.,Fulcrum) would be set. It should be noted that the search settings aredefined by an administrator. Furthermore, data buffers are initializedand primed for searching.

The search category and search text are then extracted from inputparameters. The search text are parsed for special keywords such as AND,OR, NEAR or the like. Search SQL statements are then constructed bycombining Visibility rules query, Filter Field Specification query, andactual keyword query. These constructed SQL statements are executed toperform the search. After the search has been performed or executed,results available from the search are retrieved from the selected searchengine (e.g., Fulcrum) and cached in the search adapter.

After results available from the executed or performed search have beenretrieved from the selected search engine and cached in the searchadapter, a notification is sent to the Search Center Frame 500 (shown inFIG. 5) generated by the client. After it receives the notification, theSearch Center Frame 500 calls the Search Execution Virtual BusinessComponent 2305 (shown in FIG. 23) to invoke the search and obtain theresults available from the search.

The Search Execution Virtual Business Component 2305 calls the SearchExecution Business Service 2315 (shown in FIG. 23) to retrieve thesearch results. If the Search Execution Service 2315 has previouslycached the search results, the Service 2315 would transmit the searchresult rows to the Search Execution Virtual Business Component 2305.However if the Search Execution Service 2315 has not cached the searchresults, the Service 2315 would request that the adapter 2335 sends thesearch results to the Service 2315 from the adapter's cache. The SearchExecution Service 2315 would then cache the search results and transmitthe search results to the Search Execution Virtual Business Component2305. Once the search results have been internally cached in the SearchExecution Service 2315, the connection to the search engine can beclosed.

Upon receiving the search results from the Search Execution Service2315, the Search Execution Virtual Business Component 2305 sends thesearch results to the Search Center Frame 500 (shown in FIG. 5). Thesearch results can then be displayed within the Search Center Frame 500.Users can drilldown, preview, or attach these search results, as will bedescribed below in more details.

It should be noted that even if the user closes the Search Center, theresults available from the search are still cached and can be used thenext time the user opens the Search Center since the Search ExecutionService 2315 have cached the search results. The last cached searchresults would be retained until the user terminates the user session.

Search Center User Interface

Turning back to FIGS. 4 and 5, FIG. 4 illustrates an exemplary SearchTool Bar Icon 405 in accordance with one embodiment of the presentinvention. To open the Search Center, the user click on the Search ToolBar Icon 405. FIG. 5 illustrates an exemplary Search Center Frame orPane 500 in accordance with one embodiment of the present invention.Search Center Frame or Pane 500 includes a Tool Bar section 505, aContent Area Frame 510, a Search Frame 515, and a Results Frame 520.

FIG. 24 illustrates an exemplary Search Frame 515 in accordance with oneembodiment of the present invention. Search Frame 515 includes a Closebutton 2405, which the user can choose to exit the Search Center. Inaddition, Search Frame 515 includes a “Look For” box 2410 where adropdown list of search categories and find categories will appear.Additional details about the dropdown list of search categories and findcategories will be provided below in FIG. 25 and the text describing thefigure.

Search Frame 515 further includes an update region 2415. Depending onwhat the user select from the “Look For” box, a set of controls isdisplayed in boxes 2415A, 2415B, 2415C, and 2415D.

In one embodiment, Search Frame 515 also includes the following actionbuttons: Search 2420A, Save 2420B, and Reset 2420C. Search button 2420Acan be used to go forward with the search. Save button 2420B isgenerally used to save the current search to the dropdown list. Resetbutton 2420C is typically used to clear the content of boxes 2415A,2415B, 2415C, and 2415D.

FIG. 25 shows an exemplary Search Selection View 2500 in accordance withone embodiment of the present invention. Search Selection View 2500includes a Search Selection Applet 2505. Search Section Applet 2505supports a dropdown list 2510 of search categories and find categories.When user selects a search option from the dropdown list 2510, theselected search option is saved. The selected search option can be savedin the Search Execution Service by invoking the SetSearchOption method.The saving of the search option in the Search Execution Service willclear any existing Search Categories and search text or keyword.Furthermore, Search Categories corresponding to the selected searchoption is saved in the Search Selection Service. In addition, a new viewcorresponding to the selected search option is built. As an example, ifthe user selects a search option that refers to a Search objectdescribed above in the Search Objects section, a Basic Search View willbe built. A description of an exemplary Basic Search View is providedbelow in FIG. 26 and the text describing the figure. As another example,if the user selects “Advanced Search”, an Advanced Search View will bebuilt. A description of an exemplary Advanced Search View is providedbelow in FIG. 27 and the text describing the figure.

FIG. 26 shows an exemplary Basic Search View and Basic Search ResultsView in accordance with one embodiment of the present invention. BasicSearch View includes Search Selection Applet 2605 and Basic SearchApplet 2610. Through the Search Selection Applet 2605, the user canclear the current Search Category from the Search Execution Service andthe Search Selection Service. Furthermore, the user can select a newsearch category and navigate to the appropriate view corresponding tothe newly selected search category. In addition, the user can click onthe Close button 2405 to close all applets and rebuild the master view.

Through the Basic Search Applet 2610, the user can enter search text orkeyword and select the Search button 2615. Once the user selects theSearch button 2615, the entered search text or keyword is saved in theSearch Selection Service. Then the Search Execution Business Servicestarts or invokes a search adapter corresponding to the currently chosensearch engine. The search adapter then executes the search and retrievessearch results available from the executed search. The Basic SearchResults View will then be built.

Basic Search Results View includes Search Selection Applet 2605 andBasic Search Applet 2610, which are described above. Basic SearchResults View also includes a Search Results List Applet 2620. SearchResults List Applet 2620 retrieves the search results from the SearchExecution Service. Search Results List Applet 2620 then creates dynamicfields on the business components and sets these dynamic fields withvalues from the search results.

FIG. 27 shows an exemplary Advanced Search View and Advanced SearchResults View in accordance with one embodiment of the present invention.Advanced Search View includes Search Selection Applet 2605 and AdvancedSearch Entry Applet 2710. A description of Search Selection Applet 2605is provided above. Through Advanced Search View, the user can specifyparameters for the search by selecting one or more Search Index sources2715 and entering search text or keyword in the Keyword box 2720. Oncethe user selected one or more Search Index sources 2715, entered thesearch text or keyword, and selected the Search button 2725, the searchis executed. Search results available for selected Search Categories2715 are retrieved. The retrieved search results are sorted based on theSort Specification criteria.

An Advanced Search Results View is then built to list the searchresults. Advanced Search Results View includes Search Selection Applet2605 and Advanced Search Entry Applet 2710, which are described above.Advanced Search Results View also include Advanced Search Results Applet2730. Advanced Search Results Applet 2730 retrieves the search resultsfrom the Search Execution Service, creates dynamic fields for businesscomponent based on the current search definition, and displays thesedynamic fields on the user interface.

Each of the Advanced Search View and the Basic Search View includes aView Options Search Tab 2625. View Options Search Tab 2625 enables theuser to override a search setting or certain properties of the searchsetting. View Options Search Tab 2625 includes the following controls,including Search Setting, Search Term Separator, and Search Refining. Inone embodiment, Search Setting is a dropdown list. Users with advancedstatus can utilize the Search Setting control to override the defaultsearch setting created in the Search Settings View.

It should be noted that Search Execution settings are usually created bythe administrator. One of the Search Execution settings is marked as adefault for each language. View Options Search Tab 2625 allowsadministrators or users to override the default Search Execution settingor certain properties of the setting.

FIG. 28 shows an exemplary Search Term Separator control 2800 inaccordance with one embodiment of the present invention. In oneembodiment, Search Term Separator control 2800 includes a picklist 2805with the following options: “All words (AND match)” 2810, “Any word (ORmatch) 2815, and “Exact Phrase” 2820. “All words (AND match)” option2810 specifies a search to find records or documents containing everysearch keyword entered by the user. “Any word (OR match)” option 2815specifies a search to find records or documents containing one of thesearch keywords entered by the user. “Exact Phrase” option 2820specifies a search to find records or documents containing all searchkeywords in the order that the user had entered.

FIG. 29 shows an exemplary Search Refining control 2900 in accordancewith one embodiment of the present invention. Search Refining control2900 generally lists advanced features that can be controlled on theuser interface. In one embodiment, the user can specify a proximitysearch by selecting the Proximity Search button 2905 and entering anumber in the character box 2910 of the Search Refining control 2900.

III. Search Visibility:

Single/Multi Org Visibility on Search Results

In one embodiment, a business enterprise or a customer organization thatspans multiple user groups, both internal and external to theirenterprise, may have a need for controlling access and/or visibility toapplication data within and between those groups. In one embodiment, thesearch system described herein uses a mechanism or method referred to asmultiple organizational (multi-org) visibility to provides the businessenterprise or the customer organization with an ability to manage andcontrol access to application within and between the various groups. Inone embodiment, visibility to data can be controlled or limited at theindividual level within a single organization or group. For example,visibility of various types of data (e.g., records) such as accounts,contacts, and opportunities, etc. can be controlled or limited at theindividual level within a single organization or group. In oneembodiment, access to those kinds of records can be limited to thoseindividuals whose positions have been placed on virtual teams for eachrecord. In one embodiment, access to additional data or information suchas products and price lists can also be limited. In one embodiment,these limitations of visibility are implemented and controlled at thelevel of business organizations or groups rather than at the level ofindividual users.

In one embodiment, multi-org visibility provides a logical layer abovethe visibility controls at the enterprise, limited, and personal levels.In one embodiment, the multi-org visibility method described hereinprovides the ability to limit visibility to data based on theorganization or organizations to which user positions are assigned. Inone embodiment, multi-org visibility can be applied to user data withinvarious applications, including transactional data (e.g., accounts,contacts, and opportunities, etc.), reference data (e.g., price lists,etc.), and run-time configuration data (e.g., assignment manager rulesand product configurator models, etc.).

As described herein, the multi-org visibility method/mechanism can beused to support the following functions or tasks:

Data sharing across the extended enterprise, for example, distributingsales opportunities among multiple channel partners or resellers

Applying appropriate business logic to different and diverse internalorganizations

Limiting visibility to each user's specific business context, forexample, limiting a software salesperson's visibility to softwareproduct prices rather than all product prices, including prices forhardware

Improving application performance for mobile users and executives withbroad responsibilities and many direct reports by providing more ways tolimit the number of records they retrieve from a database in a givenquery

In one embodiment, multi-org visibility is one of the ways in which dataaccess is restricted to different users. If “organizational visibility”is turned on then a user, through his pre-assigned positions, can onlysee records or data that pertain to his organization. In one embodiment,when directly accessing data stored in database tables through views inan application, organizational visibility rules can be applied as partof a database query (e.g., part of an SQL query). For example, if abusiness component called “Opportunity” is enabled for multi-orgvisibility control (multi-org enabled), then a user who chooses a viewcalled “All Opportunities View” will see all opportunities that belongto his/her organization. Since the “All Opportunities View” view is alookup on a corresponding database table called “Opportunity” table inthe database, the SQL query used to populate the data for the viewincludes the multi-org query. These visibility rules are used to ensurethat users belonging to different organizations or groups only see therecords or data that they are allowed to see (e.g., records or data towhich they have visibility).

In one embodiment, as described herein, to support full-text search, thevarious database tables in the system are indexed using a third partysearch engine, for example “Fulcrum” search engine. In one embodiment,records in the database are indexed into search indices, irrespective ofwhether a particular record can be viewed by a user or not. This type ofindexing poses a problem for searching because if visibility rules arenot applied on the search indices, then users will be able to seerecords that they don't have access to. In one embodiment, to overcomethis problem, visibility rules need to be enforced during searching.

The discussion below illustrates, in one embodiment, how visibilityrules can be implemented and enforced for searching. It should beunderstood and appreciated by one skilled in the art that the specificexamples discussed herein are for illustration and explanation purposesand should not be construed to limit the scope of the present invention.The following example uses a business component called “Literature” toillustrate how search visibility is implemented. In this example, it isassumed that the “Literature” business component needs to be indexed forsearching and is enabled for multi-org visibility. FIG. 33 shows arelationship diagram between the “Literature” business component and abusiness component called “Organization”. In this example, manyorganizations can share each literature record and many literaturerecords can be accessed by a single organization. This exampleillustrates a typical many-to-many relationship.

In one embodiment, the solution for search visibility can be implementedat various levels, for example during search administration time, whenthe admin creates the search indices and during search execution timewhen the corresponding visibility rules are applied on the searchresults.

Search Configuration and Administration Time:

In one embodiment, during search configuration time the search index isconfigured by the admin based on the following specifications:

the business component (which is based on a database table)

the fields in the respective business component to be indexed

the type of visibility to be applied on this index (in this caseorganization visibility)

In one embodiment, the search index configuration can be performed usinga set of search configuration and administration tools as describedherein.

After configuring the search index, the admin can use the SearchAdministration screens to create search indices based on theconfiguration defined above. In one embodiment, if the table beingindexed is multi-org enabled then the records can be de-normalized byalso including all organizations that are associated to each record. Inone embodiment, the de-normalization of records can be done by using anintersection table, as shown in FIG. 33.

In the example of Literature business component, while indexing therequired fields pertaining to the Literature table, for example Name,Description, etc., indexing is also done for all the Organization IDsthat are associated to each literature record. Thus, de-normalizationcan be done by using the Literature-Organization Intersection table, asshown in FIG. 33.

FIG. 34 shows a flow diagram of one embodiment of a method for indexingand de-normalizing records.

At block 3405: choose an existing business component based on a tablethat is to be indexed.

At block 3410: create a corresponding search Index object on the chosensearch-specific business component.

At block 3415: choose the fields that are to be indexed into a 3^(rd)party search index tables.

At block 3420: the type of visibility used and the associated object(e.g., Literature Organization Link) can be specified as follows:

If the Visibility Field is a Single Value Field (e.g., Organization Id),identify the corresponding column as a Visibility Column, when theSearch Index Virtual Bus Comp asks the Fulcrum Search Server to generatethe Search Table.

If the Visibility Field is a Multi-Value Field (e.g. Organization,Entitlement), identify the corresponding column as a Visibility Columnand insert one record for each value and populate the Filter Column withthe value. (i.e. denormalize the multi-value field into separate SearchTable records.)

At block 3425: Create a Search Category associated with this SearchIndex (e.g., Literature search category). This is what appears on theSearch Center UI.

At block 3430: Using Search Administration screens, generate FulcrumSearch Tables for each of the Search Indices defined previously.

At block 3435: If the visibility type is set to organization thende-normalize table as follows:

If each record to be indexed is associated with a single organization,then index all records in the base table.

If each record to be indexed is associated with multiple organizations,then de-normalize the base table first by combining with theintersection table, and then index the de-normalized data. For example,if each Literature record is associated with multiple organizations thenthe base table is “JOIN”ed with the intersection table calledLiterature-Organization Intersection table as shown in an example below:LITERATURE (DB table) ==→ FULCRUM_LITERATURE L1 O1, O2, O3 L1 O1 L2 O3,O5 L1 O2 L1 O3 L2 O3 L2 O5Search Execution Time:

In one embodiment, during search execution time, a search is not onlyperformed based on the search specification (e.g., the keyword(s)entered by the user) but also based on the visibility rules associatedwith the users. For example, when a user enters a search text containingkeyword(s) for searching, a search is performed based on the keyword(s)entered by the user but is restricted to only those rows/records thatpertain to the current user's organization. In one embodiment, since auser can only belong to one organization at a time, there will not beduplicate search results.

FIG. 35 shows one embodiment of a method according to the teachings ofthe present invention.

At block 3505: search categories for which indices have been generatedare displayed in the search center panel/UI

At block 3510: a user chooses a search category and enters a keyword forsearching. For example, the user chooses or selects a search categorycalled “Literature” and enters the keyword “sales brochure” forsearching.

At block 3515: the search frame receives the input and passes it on tothe underlying search virtual business component.

At block 3520: the “Search Execution Virtual Bus Comp” will then launcha service called the “Search Execution Service”. In one embodiment,there is a single instance of the service running for each session. Theservice is used to provide an abstraction between the business componentlayer and the search adapter layer. In one embodiment, the service thenturns around and calls the appropriate search adapter (e.g., the FulcrumSearch Adapter), which then constructs a query (e.g., Fulcrum-SQLquery). In one embodiment, this type of query is different from adatabase query. In one embodiment, the query structure constructed bythe search adapter such as the Fulcrum Search Adapter can be defined asfollows:

SELECT <select-list> FROM <fulcrum table>

WHERE (<organization-column> contains <current user's organization id>)AND

(<indexed-column> contains <keyword>)

In one embodiment, the searching based on keyword and visibility rules(e.g., organizational visibility) includes the following:

-   -   prepare the SELECT clause    -   prepare the Fulcrum table list to search on. In one embodiment,        multiple tables can be searched using a UNION clause.    -   retrieve the current user's organization Id. In one embodiment,        a user can belong to only one organization. This organization Id        is used to restrict the search to only those rows/records where        the organization Id matches that of the user.    -   once the restricted list of all rows/records that the current        user can access has been determined, the search is performed to        select from those restricted list the records that contain the        keyword entered by the user.    -   after the query executes successfully, the search results are        retrieved from the adapter and displayed on the UI search        results frame.        At block 3525: If more than one search category is chosen repeat        the above process for each category as follows:    -   UNION the Fulcrum tables, in the FROM clause    -   For each selected category:        -   Apply organization visibility rules (organization filter)            first to restrict the search to only those rows/records to            which the user has access based on the user's organization            Id.    -   Prepare one keyword clause.    -   Execute the search based on the keyword entered by the user for        each selected category.        Category Access Control Visibility on Search Results

For customers with very large volumes of master data such as literatureand products, the simple task of searching for an item of master data(or referential data) in a flat list could become a difficult task. Inone embodiment, master data are grouped and organized. The introductionof catalog and categories will enable various customers to categorizetheir data hierarchically and to navigate through the data more easily.In one embodiment, a catalog is the root category and there can bemultiple categorizations (also called catalogs). In one embodiment, thesame catalog can contain two or more master data objects (e.g.,Literature, Solution, etc.). In one embodiment, there can also beseveral category levels. In one embodiment, the ability to access (e.g.,read/update/insert/delete) or restrict access to master data can be doneby associating user groups to any category in the hierarchy.

User Groups

In one embodiment, various users of the system are organized intovarious user groups. This allows people and accounts to be organizedinto groups that can be assigned to have, or not have, visibility tovarious categories of master data. In one embodiment, the association ofusers to various categories of master data is established in varioususer interfaces called the Catalog Administration screens. For example,when an end user browses through a catalog or invokes a pick list, theuser will only see the accessible categories or items in thoseaccessible categories.

FIG. 36 illustrates a diagram of one embodiment of a logical data modelaccording to the teachings of the present invention. At a high level,this is a logical data model that describes the concept of categoryaccess control which includes managing users, managing master data, andmanaging the access of users to master data.

As shown in FIG. 36, the logical data model 3600 includes the MasterData block 3610, the Access Control block 3620, and the Party block3630. According to the teachings of the present invention, ahierarchical mechanism is introduced as described herein for organizingdata in a more accessible manner. In one embodiment, the access controlblock 3620 is used as a control structure to control/limit access of theparty block 3630 to the master data block 3610.

FIG. 37 shows a more detailed block diagram of one embodiment of thelogical data model illustrated in FIG. 36.

In one embodiment, when data (stored in database tables) are beingaccessed directly through various views in an application, categoryaccess control visibility rules are applied as part of the database SQLquery. For example, if the business component “Literature” is accesscontrol enabled, then a user will only see categories and literatureitems under categories that he or she has access to. The list ofcategories that a user has access to is determined at runtime bydetermining the user groups he belongs to and the access type.

But since full-text searches are performed against the 3^(rd) partysearch indices rather the system or internal database, the accesscontrol in this context is implemented slightly differently as describedbelow. As discussed above with respect to the organization visibilityrules, records in the database are indexed into search indices of aparticular search engine (e.g., Fulcrum search indices), irrespective ofwhether a particular record can be viewed by a user or not. Accesscontrol visibility rules are applied on the search results as describedin more details below.

The following example illustrates one embodiment of the access controlvisibility rules. In this example, assuming that the Literature businesscomponent is a business component that needs to be indexed and is accesscontrol enabled. This means that all Literature records in thecorresponding database table have been assigned to various categoriesand user groups already have been assigned access to these categories ofmaster data.

The processes described below are similar to the processes describedabove with respect to the search organizational visibility rules exceptthat “Organization” is now “Content Category”. In one embodiment, adifference is that the search results may repeat for the same search.For example, if the same Literature item is associated with twodifferent categories and if the same user has access to these twodifferent categories, then the search results for this Literature itemwill appear twice with the difference being the categories that theybelong to.

FIG. 38 shows a block diagram of one embodiment of a logical data model3800 illustrating the relationship between various business components(e.g., the Literature business component and the Category businesscomponent, etc.).

The discussion below illustrates, in one embodiment, how category accesscontrol visibility on search can be implemented. It should be understoodand appreciated by one skilled in the art that the specific examplesdiscussed herein are for illustration and explanation purposes andshould not be construed to limit the scope of the present invention. Inone embodiment, category access control visibility can be implemented atvarious levels, for example during search administration andconfiguration time when search indices are created and during searchexecution time when the corresponding access control visibility rulesare applied or enforced.

Search Configuration & Administration Time:

In one embodiment, during search configuration time the search index isconfigured by the admin based on the following specifications:

the business component (which is based on a database table)

the fields in the respective business component to be indexed

the type of visibility to be applied on this index (in this casegroup/access control visibility)

In one embodiment, the search index configuration can be performed usinga set of search configuration and administration tools described herein.

After configuring the search index, the admin can use the SearchAdministration screens to create search indices based on theconfiguration as described above. In one embodiment, if the table beingindexed is access control enabled then the records can be de-normalizedby including all categories that are associated to each record. In oneembodiment, the de-normalization of records can be done by using anintersection table (e.g., the Literature-Category intersection table asshown in FIG. 38 above).

In the example of Literature business component, while indexing therequired fields pertaining to the Literature table, for example Name,Description, etc., indexing is also done for all the Category IDs thatare associated to each literature record. Thus, de-normalization can bedone by using the Literature-Category Intersection table, as shown inFIG. 38.

FIG. 39 shows a flow diagram of one embodiment of a method according tothe teachings of the present invention for indexing and de-normalizingrecords.

At block 3905: choose an existing business component based on a table tobe indexed.

At block 3910: create a corresponding search index object on the chosensearch-specific business component.

At block 3915: choose the fields to be indexed into a 3^(rd) partysearch index tables.

At block 3920: choose the type of visibility used and the associatedobject (e.g., Literature Category Link).

At block 3925: include the Category Name field from the Categorybusiness component. This can be used for classifying search results asdiscussed below.

At block 3930: create a search category and associate the search indexto it. This is what appears on the Search Center UI.

At block 3935: using Search Administration screens, generate FulcrumSearch Tables for each of Search Indices defined previously.

At block 3940: if the visibility type is set to access control thende-normalize table as follows:

If each record to be indexed is associated to multiple categories, thende-normalize the base table first by combining with the intersectiontable, and then index the de-normalized data. For example, if eachLiterature record is associated to multiple categories then the basetable is “JOIN”ed with the intersection table Literature-CategoryIntersection table as shown below: LITERATURE (DB Table) ==→FULCRUM_LITERATURE L1 C1, C2, C3 L1 C1 L2 C3, C5 L1 C2 L1 C3 L2 C3 L2 C5Search Execution Time:

In one embodiment, at search time, a search is not only performed basedon the search specification or criteria (e.g., the keyword(s) entered bya user) but also based on the access control visibility rules associatedwith that particular user. For example, when a user enters a search textcontaining keyword(s) for searching, a search is performed based on thekeyword(s) entered by the user but is restricted to only thoserows/records that are accessible to the user based on the access controlvisibility rules. In one embodiment, since a user can have access tomultiple categories, search results can have duplicate entries (e.g.,the same entry can belong to two different categories).

FIG. 40 shows a flow diagram of one embodiment of a process according tothe teachings of the present invention.

At block 4005: the search center displays search categories for whichindices have been generated as described above.

At block 4010: a user chooses a search category and enters a keyword forsearching. For example, the user chooses or selects a search categorycalled “Literature” and enters the keyword “sales brochure”.

At block 4015: the search frame receives the input from the user andpasses it on to the underlying search virtual business component.

At block 4020: the “Search Execution Virtual Bus Comp” will then launcha service called the “Search Execution Service”. In one embodiment,there is a single instance of the service running for each session. Theservice is used to provide an abstraction between the business componentlayer and the search adapter layer. In one embodiment, the service thenturns around and calls the appropriate search adapter (e.g., the FulcrumSearch Adapter), which then constructs a query (e.g., Fulcrum-SQLquery). In one embodiment, this type of query is different from adatabase query. In one embodiment, the query structure constructed bythe search adapter such as the Fulcrum Search Adapter can be defined asfollows: SELECT <select - list> FROM <fulcrum table> WHERE(<category-column> contains <all valid access control categories>) AND   (<indexed-column> contains <keyword>)In one embodiment, the process of searching based on keyword and accesscontrol visibility rules includes the following:

-   -   Prepare the SELECT clause    -   Prepare the Fulcrum table list to search on. In one embodiment,        multiple tables can be searched by using a UNION clause.    -   Retrieve all the categories that the user has access to. In one        embodiment, this is done by determining all the user groups that        the user belongs to and determine the categories that these user        groups are associated to. This query returns all the valid        access control categories that the current user has access to.        Using these category Ids, an OR clause is constructed to        restrict the search to only those rows/records whose Category Id        matches this list.    -   Once the restricted list of all rows/records that the current        user can access has been determined, the search is performed for        the rows/records which contain the keyword entered by the user.    -   After the query executes successfully, retrieve search results        from the adapter and display the search results on the UI search        results frame.        At block 4025: if more than one search category is chosen repeat        the above process for each category as follows:    -   UNION the Fulcrum tables in the FROM clause    -   For each selected category        -   Apply category visibility rules (category filter) first to            restrict the search to only those rows/records to which the            user has access, based on the corresponding user groups and            the categories associated with these user groups.    -   Prepare one keyword clause.    -   Execute the search in Fulcrum based on the keyword entered by        the user for each selected category        Invisible/Implicit Filtered Searches

In one embodiment, “invisible” or “implicit” search filters are built sothat search results will be automatically filtered out based on theinvisible/implicit query.

Invisible Search Filters:

In one embodiment, for each search index (and more specifically a searchtable) object, users can define filter fields. These filter fields areused specifically for the purpose of filtering search results. In thecase of using a search engine such as Fulcrum, these business componentfields map directly to a Fulcrum column (e.g., in the Fulcrum searchtable) and are indexed as part of the regular indexing process asdescribed herein. In one embodiment, the indexing is done directly atthe database level and not at the business component level.

The concept of invisible/implicit filtering is introduced to solve aproblem explained in the following example. In one embodiment of thesystem configuration, different types of documents may be stored in thesame table. For example, Solutions and Resolution documents may be savedin the same table called S_RESITEM. Currently, records of differenttypes of documents are distinguished using a flag field or flag column(e.g., a flag called SOLUTION_ITEM_FLG). For example, a “Y” value inthis flag column indicates a solution record. In order to filter searchresults that pertain only to solutions, at runtime, some filter searchspecifications need to be used. In one embodiment, filter searchspecifications are similar to business component search specificationsand work similarly. The process of creating and using filter fields forfiltering of search results are discussed in more details below.

Search Configuration Time

FIG. 41 illustrates a flow diagram of one embodiment of a methodaccording to the teachings of the present invention for creating filtersearch specifications.

At block 4105: identify the business component to be indexed (e.g.,Solution business component)

At block 4110: configure a search index for the above business component(e.g., Solution business component)

At block 4115: specify a search table for the search index and for aparticular search engine (e.g., FUL_SOLN for Fulcrum search engine)

At block 4120: identify the fields in the business component that willserve as filter fields. In one embodiment, the field types that aresupported are Varchars or Char fields.

At block 4125: define the filter fields under the Search Table object.Specify the column name in the Fulcrum search table for instance, alongwith other attributes, such as Data Type, Index Mode, etc.

At block 4130: create a search category associated to this Search Index.For example, create a search called All Solutions

At block 4135: create a search definition under the search engine (e.g.,search engine Fulcrum). For example, create a search definition called“Call Center Search Definition”. As described above, a search definitionis a group of search categories

At block 4140: a search definition is associated to an application. Whenan application is launched, categories that belong to the searchdefinition are displayed in the UI of the Search Center.

At block 4145: associate the search category “All Solutions” to thissearch definition

At block 4150: define a filter search specification for this category tofilter only one type of records (e.g., solution records). For example,the filter specification in this case may be specified as [SolutionItem]=‘Y’. In one embodiment, supported filtered search specificationsyntax are described below.

At block 4155: at runtime or execution time the filter searchspecification is parsed and applied to the search results pertaining tothe corresponding category. Supported filtered search specificationsyntax are described below.

Search Execution Time:

In one embodiment, at search execution time, a search is not onlyperformed based on keyword entered by a user but also the filter searchspecification. For example, when the user enters a search textcontaining the keyword(s), a search is performed based on the keywordentered by the user but is restricted to only those rows/records thatsatisfy the filter search specification clause. In one embodiment, thefilter search specification can co-exist with the visibility searchspecification described above (e.g., organizational visibility searchspecification or category access control visibility searchspecification)

FIG. 42 shows a flow diagram of one embodiment of a method according tothe teachings of the present invention. As illustrated in this example,search is performed based on keyword and filter search specification.

At block 4205: search center displays search categories for whichindices have been generated as described above

At block 4210: a user chooses a search category and enters a searchkeyword. For example, the user chooses a search category called“Solution” and enters the keyword “Sales brochure”.

At block 4215: the search frame receives the input and passes it on tothe underlying search virtual business component.

At block 4220: the “Search Execution Virtual Bus Comp” will then launcha service called “Search Execution Service”. In one embodiment, there isa single instance of the service running for each session. The serviceis used to provide an abstraction between the business component layerand the search adapter layer. In one embodiment, the service then turnsaround and calls the appropriate search adapter (e.g., the FulcrumSearch Adapter), which then constructs a query (e.g., Fulcrum-SQLquery). In one embodiment, this type of query is different from adatabase query. In one embodiment, the query structure constructed bythe search adapter such as the Fulcrum Search Adapter can be defined asfollows: SELECT <select - list> FROM <fulcrum table> WHERE ((<visibilityconstraint>) AND (<filter column> = <filter search spec>)) AND   (<indexed-column> contains <keyword>)In one embodiment, the searching based on keyword and invisible/implicitsearch filters includes the following:

-   -   Prepare the SELECT clause    -   Prepare the Fulcrum table list to search on. In one embodiment,        multiple tables can be searched by using a UNION clause.    -   Prepare the visibility clause based on multi-org visibility        rules and/or access control visibility rules as described above.    -   Parse the search specification to conform to Fulcrum SQL syntax.    -   Append the filter search specification along with the visibility        constraint (based on multi-org visibility and/or access control        visibility)    -   Prepare the actual keyword constraint    -   After the query executes successfully, retrieve search results        from the search adapter and display the search results on the UI        search results frame.        At block 4225: If more than one search category is chosen repeat        the above process for each category as follows:    -   UNION the Fulcrum tables, in the FROM clause    -   For each selected category:        -   Apply visibility clause        -   Apply filter field clause    -   Prepare one keyword clause.    -   Execute the search in the search adapter (e.g., Fulcrum) based        on visibility rules, search filer specification, and keyword.        Supported Filter Search Spec Syntax

In one embodiment, the filter search specification syntax that aresupported are shown below:  [filter expression] {<Boolean operator>[filter expression] ...}   [filter expression] :: [Filter Field Name][operator]  [Value]    [filter field name] : name of the filter fieldbelonging    to the search category    [operator] : =, <>, LIKE, NOTLIKE     LIKE and NOT LIKE support the wildcards * and &    [value] :the value of the field. For e.g., ‘Y’ .     or it could be a function“LookupValue (<LOV Name>,    <Independent LOV code>)” <Boolean Operator>:: OR, AND

EXAMPLES

( [Type] = LookupValue (“SALES_TOOL_TYPE”,) “Sales Tool”) OR [Type] =LookupValue (“SALES_TOOL_TYPE”, “Sales Tool Brochure”) ) AND [Flag] = ‘Y’Search Results Attachment/PreviewAttachment

In one embodiment, a record in the search results list applet or findresults list applet can be attached or associated to an active parentobject in the content area. In one embodiment, in order to attach arecord in the search results list applet or find results list applet toan active parent object in the content Area, the relationship betweenthem is required to be M-to-M relationship. In one embodiment, thisrelationship is implemented by creating a link between the two businesscomponents with an intersection table. In one embodiment, if a searchcategory or find object is one of the business components of a businessobject and there is an M-to-M link between them, the search resultrecord or row can be attached to the respective object.

In one embodiment, the attachment (also called association) is createdin the business object layer in the multiple-layered systemarchitecture. In one embodiment, to provide the user with the ability togo to a view directly to verify the association or attachment, a featurecalled “Pick View” is added to a corresponding search category or findobject. The pick view defines the view that user can go to afterassociation happens, as well as the candidate association. Accordingly,new Pick Views can be added to search category or find object usingsearch tools that are described above.

As described above, in search tools, pick view can be accessed underSearch Category and Find Object. These pick views' business objects areable to accept the association as described above. In one embodiment,the applet name defined in a pick view is the applet where users add asearch result record.

In one embodiment, the association of external documents to a pick viewis supported. Generally, this pick view is called “XXX Attachment.” Therestriction of this association is different from the association ofdatabase record. In one embodiment, this applet should be based onCSSSWEFrameListFile and its business component should be based onCSSBCFile. This applet may contain optional fields, such as description.In one embodiment, these fields will not be filled when the attachmentis created.

As described herein, each search category has an attribute called searchindex. In one embodiment, an attribute called “DB Table” of search indexis used to determine if search result row/record is an external documentor database record. For example, if this attribute is set to aparticular value such as false, then the corresponding search categoryis assumed to be an external document.

Preview

In one embodiment, preview of a result record is included as a featureof the search system described herein. In one embodiment, in order topreview a result record, a drilldown view is required. In oneembodiment, the drilldown view, drilldown business component anddestination field are defined using search tools in search category orfind object. In one embodiment, the drilldown view will show up in apopup browser. As mentioned above, in one embodiment, preview ofexternal documents is also supported.

User Procedures

The following illustrates an example of how customer support personneluses the preview and attachment features included in the search systemdescribed herein. In this example, a customer support personnel in “XYZ”company runs the system call center web client and goes to a screencalled the service screen. Assuming that he has a service request in hisqueue regarding networks card product. He reads the description of theproblem. He notices that it might be a known problem and there isalready a solution for it. He then opens the search center pane, selectssolution, and types in keyword “Networks Card”. He then executes thesearch and gets a lot of solution items. He identifies an appropriatesolution for the current problem by clicking the Preview button for eachrow/record in the result list. After he identifies the appropriatesolution, he then clicks the Attach button. This operation attaches theresult row/record to the current service request, and then brings him tothe correct view to review the association. He then writes to hiscustomer (e.g., via an email) with the solution he found and updates thestatus of the service request. FIG. 43 shows a flow diagram of oneembodiment of a process described in the above example.

Administrator Procedures

As described above, new pick views for an existing search category or anew search category can be configured using search tools as describedabove. In one embodiment, the following pick views are implemented inthe search system described herein:

Solution

-   -   Service Request Solution View. Applet: SR Solution List Applet    -   Resolution Documents Administration View. Applet: Solution List        Applet w/Publish Internal For Resolution Document        Product    -   Activity Product View. Applet: Product List Id Drilldown Applet        Document    -   Admin Sales Tools List. Applet: Literature List Administration        Applet    -   Agreement Attachments View. Applet: Agreement New Attachment        List Applet    -   Asset Mgmt—Asset Attachment. Applet: Asset Mgmt—Asset Attachment        List Applet    -   Defects Detail w/attachments. Applet: PD Attachment List Applet    -   Resolution Documents Administration View. Applet: SR Resolution        Item List Frame

In one embodiment, the following Find Object Pick Views are alsoimplemented in the search system described herein:

Account

-   -   Opportunity Detail—Indirect Accounts View. Applet: Indirect        Accounts List Applet        Corporate Contact    -   Account Detail—Contacts View. Applet: Account Contact List        Applet    -   Activity Contacts View. Applet: Contact (All) List Applet    -   Channel Partner Detail—Contacts View. Applet: Partner Contact        List Applet    -   Opportunity Detail—Contacts View. Applet: Oppty Contact List        Applet        Opportunity    -   Contact Detail—Opportunities View. Applet: Opportunity List        Applet—Basic        Product Defect    -   Asset Mgmt—Asset Related Defects List View. Applet: Product        Defect List Applet—Other        Service Request    -   Related Service Requests. Applet: Service Request List Applet

In one embodiment, to configure a new pick view for a search category orfind object, the requirements are as follows:

-   -   The view contains the applet in View Web Template Item,    -   The applet is based on the same business component as the search        category,    -   The business object that the pick view belongs to contains the        search category or find object as one of its sub business        components. A link is required between the primary business        component and the search category or find object. The link is        required to be an M-to-M relationship (e.g., an intersection        table exists in the link).

In one embodiment, the data model specification is as follows:

S_SRCH_PICKVIEW

1. “VIEW_NAME” as VARCHAR2 (75)

2. “APPLET_NAME” as VARCHAR2 (75)

In one embodiment, this table will be compiled into a repository fileand is configurable using search tools as described above. The parentobject for Search Pick View is search category. Accordingly, a SearchCategory can have multiple Pick Views.

In one embodiment, VIEW_NAME maps to attribute View Name. It is used tocompare the view in the Content Area in Web client. In one embodiment,APPLET_NAME maps to attribute Applet Name. It is used to specify theapplet to which a search result record can be added.

FIG. 44 shows a flow diagram of one embodiment of anattachment/association process according to the teachings of the presentinvention.

At block 4405: call a method named m_pFrameMgr::GetView to get thecurrent view in the content area pane.

At block 4407: check in the repository to see if the current view is inthe list of pick view of the active result record's search category. Ifthe current view is not in the list of pick view, get the screendefinition, then look for the first candidate view that is in the pickview and is in the current screen.

At block 4409: get the reference to the frame to which the result recordwill be added.

At decision block 4411: check if the search category is an externaldocument. If it is an external document, proceed to block 4421,otherwise proceed to block 4431

If the search category is an external document:

-   -   At block 4421: create new record in the applet.    -   At block 4423: call a method named CSSBCFile::CreateFile to load        the file to the file system.    -   At block 4425: write record.        else    -   At block 4431: invoke a method named CSSBusComp::GetAssocList (        ) to get the associate list.    -   At block 4433: invoke a method named CSSAssocList—>SetSearchSpec        ( ) to locate the record    -   At block 4435: invoke Execute( ), Home ( ). Then there should be        only one record.    -   At block 4437: invoke a method named        CSSAssocList::AssocCurrentRow ( ) to associate the record        end        At block 4441: invoke a method named m_pFrameMgr::BuildViewAsync        to refresh the view in the Content Area. If the view is not the        Pick View, build the Pick View in the Content Area.

FIG. 45 shows a flow diagram of one embodiment of a preview processaccording to the teachings of the present invention.

At block 4505: check if the search category is an external document. Ifthe search category is an external document, proceed to block 4511.Otherwise proceed to block 4531. If the search category is an externaldocument

-   -   At block 4511: retrieve the file path    -   At block 4513: retrieve the pointer to CSSSWEHttpResponse from        m_pFrameMgr    -   At block 4515: get the output stream from the CSSSWEHttpResponse    -   At block 4517: write the file content to the output stream    -   At block 4519: look up and set the Content Type    -   At block 4521: invoke a method named m_pFrameMgr::PostActionDone        ( )        else    -   At block 4531: retrieve drilldown view, drilldown business        component and destination field from the search category or find        object definition of the selected result row/record.    -   At block 4533: check if the view is accessible    -   At block 4535: get the business object of the view.    -   Locate the row by setting the search spec.    -   At block 4537: invoke a method named        m_pFrameMgr::BuildViewAsync. The view id is set to        SWE_HTML_POPUP_WINDOW_STR so that the view will show up in the        popup browser        end        V. Remote Client Search        Overview

In one embodiment, the system described herein also includes a featureor mechanism to enable downloads of search index files to a remoteclient. The system currently provides the capability for creating searchindices through a search administration screen for both mobile as wellas connected clients.

Currently mobile users need to use the search administration screen tocreate indices locally on their machines. Since creating search indicesis a time-consuming task, the present invention provides a new mechanismso that the mobile users can create search indices more efficiently. Inone embodiment, search indices will be created on the server and savedas file attachments in the database. During synchronization time thesefiles can be downloaded to the mobile client's machine.

In one embodiment, at least a new table is required to support the newfunctionality. The schema for the new table is described in the DataModel section below.

In one embodiment, before actually executing a search, it is necessaryto make sure that the indices are copied to the correct searchdirectories on the local machine. In one embodiment, a view called theSearch Index Request View is used to get the search indices to thecorrect directory.

FIG. 46 illustrates a high level flow diagram of one embodiment of aprocess for performing remote search indexing. In one embodiment, theuser is required to choose which index objects he wish to search on andmark them for download. Next, a database sync operation is performed todownload the index files as attachments. The user then clicks theuncompress button on the Search Index Request View to uncompress theindex files into the correct directory.

FIG. 47 shows a flow diagram of one embodiment of a process foruploading indices to DB and file server and for downloading indices to aremote client.

Upload Indices to DB and File Server:

At block 4705: save the Fulcrum generated files like the catalog,dictionary files, etc., along with the character set information and thesetting name in the database as file attachments. In one embodiment,this is done every time an index file is created or refreshed.Accordingly, the most current index files are stored as attachments inthe database

Download Indices to a Remote Client:

At block 4710: go to the Search Index Request View, select the searchindices that are wanted for searching (e.g., check the download columnfor each search index that is wanted for searching).

At block 4715: perform a database synchronization to download the indexfile attachments into the local database

At block 4720: go back to the Search Index Request View, click on theUncompress button to uncompress the search index file attachments intothe correct directory on the local machine.

At block 4725: once the indices and other files are copied, searches canbe performed against them.

In one embodiment, subsequent downloads from the server to the DB tablewill only happen if the Revision Number has changed on the Search IndexFiles. In this case, the user will have to once again uncompress theindex files as described above.

FIG. 48 shows an example of one embodiment of a search index requestview (UI). As shown in FIG. 48, the search index request view includes alist of search indices that can be selected (e.g., by checking thecorresponding download column) to down load the corresponding index fileattachments into the local database. The uncompress button is used touncompress the search index file attachments into the correct directoryon the local machine.

Data Model Specification

In one embodiment, the schema for the tables used according to theteachings of the present invention are illustrated below:

S_SRCH_INDXINFO

In one embodiment, this is a table to hold search index relatedinformation. This table may include the index name, engine name andcharacter set (or code page), etc. CREATE TABLE S_SRCH_INDXINFO (ROW_IDVARCHAR2 (15) not null ,CREATED DATE default sysdate not null,CREATED_BY VARCHAR2 (15) not null ,LAST_UPD DATE default sysdate notnull ,LAST_UPD_BY VARCHAR2 (15) not null ,MODIFICATION_NUM NUMBER (10,0) default 0 not null ,CONFLICT_ID VARCHAR2 (15) default ‘0’ not null,INDEX VARCHAR2 (75) not null - name of the index ,SRCH_ENGINE_CDVARCHAR2 (75) not null - name of search engine ,CHARACTER_SET VARCHAR(75) not null - name of the character set ) ; create unique indexS_SRCH_INDXINFO_P1 on S_SRCH_INDXINFO (ROW_ID) ; create unique indexS_SRCH_INDXINFO_U1 on S_INDXINFO (CHARACTER_SET, SRCH_ENGINE_CD, INDEX);S_SRCH_INDXINFO_ATT

In one embodiment, this is a table to hold all search index related fileattachments for a search engine+search index+character set (or codepage)combination. CREATE TABLE S_SRCH_INDXINFO_ATT (ROW_ID VARCHAR2 (15) notnull ,CREATED DATE default sysdate not null ,CREATED_BY VARCHAR2 (15)not null ,LAST_UPD DATE default sysdate not null ,LAST_UPD_BY VARCHAR2(15) not null ,MODIFICATION_NUM NUMBER (10, 0) default 0 not null,CONFLICT_ID VARCHAR2 (15) default ‘0’ not null ,PAR_ROW_ID VARCHAR2(15) not null -- FK to S_SRCH_INDXINFO ,DIRTY_READ CHARACTER (1) defaulttrue -- a flag that indicates if the index file -- attachments havechanged/refreshed --- since the last synch. ,FILE_NAME VARCHAR2 (200) --file name -- and other file related columns ) ; create unique indexS_SRCH_INDXINFO_ATT_P1 on S_INDXINFO_ATT (ROW_ID) ; create indexS_SRCH_INDXINFO_ATT_F1 on S_SRCH_INDXINFO_ATT (PAR_ROW_ID) ;

FIG. 49 shows a flow diagram of one embodiment of a process for remoteclient search indexing according to the teachings of the presentinvention.

At block 4905: after each index is created or refreshed, the index filesare attached to the file system and records are inserted into theS_SRCH_INDXINFO_ATT table. The associated character set and index isrecorded in the S_SRCH_INDXINFO table.

At block 4910: when a mobile user needs to use the search capability, heneeds to first download the search indices. In one embodiment, in orderto download the search indices, the mobile user navigates to the SearchIndex Request View. Once in this view the user clicks on the downloadcheck box for the index that he would like to download. In oneembodiment, when the user checks the download box, the system goesthrough the S_SRCH_INDXINFO_ATT table and mark the associated indexattachment files to be requested next time a database synchronization isperformed.

At block 4915: the user then performs a database synchronization, whichwill retrieve the marked index files onto the remote user's machine. Inone embodiment, if the index files have not changed since the lastsynchronization they will not be downloaded.

At block 4920: the user then returns to the Search Index Request View.The user then clicks on the Uncompress button in order to decompress theattachment files and place them into the correct directory. After theprocess is complete the remote user will be able to search using searchindices.

It should be noted that the functional components, as shown above in thefigures and described in the text accompanying the figures, could beimplemented using software code segments. If the aforementionedfunctional components are implemented using software code segments,these code segments can be stored on a machine-readable medium, such asfloppy disk, hard drive, CD-ROM, DVD, tape, memory, or any storagedevice that is accessible by a computing machine.

The invention has been described in conjunction with the preferredembodiment. It is evident that numerous alternatives, modifications,variations and uses will be apparent to those skilled in the art inlight of the foregoing description.

1. A method, comprising: receiving search criteria; defining an indexfield map object to map one or more business components to one or moreresult fields associated with a search engine, the index field mapobject including an index field type; performing a search for datarecords matching the search criteria using the search engine, the searchcomprising searching in a plurality of databases, wherein the searchfurther comprises searching at least one attached document stored in afile system if the index field type indicates the search is to beperformed on the file system; and generating search results comprisingof the data records matching the received search criteria.
 2. The methodof claim 1, wherein receiving search criteria further comprisesreceiving at least one search category entered by a user.
 3. The methodof claim 1, wherein receiving search criteria further comprisesreceiving at least one search keyword entered by a user.
 4. The methodof claim 1, further comprising: passing the received search criteria toa Virtual Business Component (VBC) if the search is to be performed onat least one external database.
 5. The method of claim 4, furthercomprising: passing the received search criteria from the VirtualBusiness Component to a search execution business service.
 6. The methodof claim 1, wherein performing the search further comprises: using asearch execution business service to search the plurality of databasesfor data records matching the search criteria; and using the searchexecution business service to search the at least one attached documentin the file system for data records matching the search criteria.
 7. Themethod of claim 1, further comprising: sending the search results to aframe so that the search results can be listed on a user interface. 8.The method of claim 7, further comprising: displaying content of asearch result selected from the search results listed on the userinterface.
 9. (canceled)
 10. A method, comprising: receiving a searchcategory and a search keyword entered by a user; defining an index fieldmap object to map one or more business components to one or more resultfields associated with a search engine, the index field map objectincluding an index field type; searching at least one database and atleast one attached document for data records matching the searchcategory and the search keyword using the search engine based on a valueof the index field type; and generating search results comprising of thedata records matching the search category and the search keyword. 11.The method of claim 10, further comprising: passing the received searchcategory and the search keyword to a Virtual Business Component (VBC) ifthe user requested the single search to be performed on at least oneexternal database.
 12. The method of claim 11, further comprising:passing the received search category and the search keyword from theVirtual Business Component to a search execution business service. 13.The method of claim 10, wherein searching the database furthercomprises: using a search execution business service to search the atleast one database and the at least one attached document for datarecords matching the search criteria.
 14. The method of claim 10,further comprising: sending the search results to a frame so that thesearch results can be listed on a user interface.
 15. The method ofclaim 14, further comprising: displaying content of a search resultselected from the search results listed on the user interface.
 16. Asystem, comprising: a user interface to receive search criteria enteredby a user; a search engine associated with one or more result fields,the one or more result fields are mapped to one or more businesscomponents by an index field map object, the index field map objectincluding an index field type; a file system coupled to the searchengine to store attached documents; and a business service to perform asearch for data records matching the search criteria using the searchengine and to generate search results comprising of the data recordsmatching the received search criteria, wherein the search comprisessearching at least one database and the search further comprisessearching at least one attached document in the file system if the indexfield type indicates the search is to be performed on the file system.17. The system of claim 16, wherein the search criteria comprises atleast one search category.
 18. The system of claim 16, wherein thesearch criteria comprises at least one search keyword.
 19. The system ofclaim 16, wherein the business service sends the search results to theuser interface so that the search results can be listed on the userinterface.
 20. The system of claim 19, wherein the user interfacedisplays in a content area frame_a search result selected from thesearch results listed on the user interface.
 21. A system, comprising: auser interface to receive search criteria entered by a user; a VirtualBusiness Component (VBC) to receive the search criteria from the userinterface if the user requested a search on at least one externaldatabase; a search engine associated with one or more result fields, theone or more result fields are mapped to one or more business componentsby an index field map object, the index field map object including anindex field type; and a business service to receive the search criteriafrom the Virtual Business Component and to search a plurality ofdatabases and at least one attached document for data records matchingthe search criteria using the search engine based on a value of theindex field type.
 22. The system of claim 21, wherein the searchcriteria comprises at least one search category.
 23. The system of claim21, wherein the search criteria comprises at least one search keyword.24. The system of claim 21, further comprising: a search adapter toadapt to a selected search engine and to generate search resultscomprising of the data records matching the received search criteria.25. The system of claim 21, wherein the business service sends thesearch results to a search frame so that the search results can belisted on the user interface.
 26. (canceled)
 27. A machine-readablemedium comprising instructions which, when executed by a machine, causethe machine to perform operations comprising: receiving search criteriaentered by a user; defining an index field map object to map one or morebusiness components to one or more result fields associated with asearch engine, the index field map object including an index field type;performing a search on a plurality of databases and at least oneattached document for data records matching the search criteria usingthe search engine based on a value of the index field type; andgenerating search results comprising of the data records matching thereceived search criteria.
 28. The machine-readable medium of claim 27,wherein receiving search criteria further comprises receiving at leastone search category and at least one search keyword.
 29. Themachine-readable medium of claim 27, further comprising: sending thesearch results to a search frame so that the search results can belisted on a user interface.
 30. The machine-readable medium of claim 29,further comprising: displaying in a content area frame a search resultselected from the search results listed on the user interface.
 31. Thesystem of claim 16, further comprising a Virtual Business Component(VBC) to receive the search criteria from the user interface if the userrequested a search on at least one external database.